

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Documentation for pyamp &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="#" />
    <link rel="next" title="Introduction" href="intro.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="intro.html" title="Introduction"
             accesskey="N">next</a> |</li>
        <li><a href="#">pyamp v1.2 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="documentation-for-pyamp">
<h1>Documentation for pyamp<a class="headerlink" href="#documentation-for-pyamp" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#about">About</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#licensing">Licensing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installing pyamp</a></li>
<li class="toctree-l1"><a class="reference internal" href="_generated/mod_pyamp.html">The pyamp module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_documentation.html">The documentation module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_documentation_rstGeneration.html">The rstGeneration module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_logging.html">The logging module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_logging_colors.html">The colors module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_logging_logger.html">The logger module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_logging_prefix.html">The prefix module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_logging_loggable.html">The loggable module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_logging_meta.html">The meta module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_patterns.html">The patterns module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_patterns_interfaces.html">The interfaces module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_patterns_borg.html">The borg module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_patterns_decorators.html">The decorators module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_patterns_enum.html">The enum module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_ui.html">The ui module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_ui_qt.html">The qt module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_ui_input.html">The input module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_web.html">The web module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_web_html.html">The html module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_web_http.html">The http module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_web_hacking.html">The hacking module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_web_web.html">The web module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_networking.html">The networking module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_networking_sockets.html">The sockets module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_config.html">The config module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_config_configFile.html">The configFile module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_config_option.html">The option module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_config_parser.html">The parser module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_config_conversions.html">The conversions module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_system.html">The system module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_system_ubuntu.html">The ubuntu module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_util.html">The util module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_inspection.html">The inspection module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_lists.html">The lists module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_functions.html">The functions module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_html.html">The html module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_debugging.html">The debugging module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_setup.html">The setup module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_objects.html">The objects module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_dictionary.html">The dictionary module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_directories.html">The directories module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_sockets.html">The sockets module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_util_strings.html">The strings module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/mod_pyamp_processes.html">The processes module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/mod_pyamp_processes_threading.html">The threading module</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_processes_coroutine.html">The coroutine module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="_generated/pyamp_exceptions.html">The exceptions module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_exceptions.html#the-finalfunctionerror-class">The FinalFunctionError class</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_exceptions.html#the-invalidpropertyvalueerror-class">The InvalidPropertyValueError class</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_exceptions.html#the-undefinedfunctionerror-class">The UndefinedFunctionError class</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_exceptions.html#the-undefinedpropertyerror-class">The UndefinedPropertyError class</a></li>
<li class="toctree-l3"><a class="reference internal" href="_generated/pyamp_exceptions.html#the-invalidconfigurationpropertyvalueerror-class">The InvalidConfigurationPropertyValueError class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-2">Release 1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-1">Release 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-1-0">Release 1.0</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Documentation for pyamp</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="intro.html"
                        title="next chapter">Introduction</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/index.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="intro.html" title="Introduction"
             >next</a> |</li>
        <li><a href="#">pyamp v1.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>